home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1997 July / EnigmA AMIGA RUN 20 (1997)(G.R. Edizioni)(IT)[!][issue 1997-07 & 08][EAR-CD IV].iso / earcd / text / edit / ged_asci.lha / GED_AsciiReg.txt < prev   
Text File  |  1997-04-22  |  5KB  |  151 lines
  1. GED_AsciiReg V1.2 documentation
  2. *******************************
  3.  
  4. Author: Thies Wellpott
  5. Date: 22.4.1997
  6.  
  7.  
  8. Why this program?
  9. ================
  10.  
  11. The GoldED GUI configuration is quite nice but especially the editing of
  12. commands lacks powerful copying and pasting capabilities. GED_AsciiReg
  13. converts the registry files to ASCII files which can be edited with any
  14. text editor (GoldED perhaps?) and then converts the ASCII file back.
  15.  
  16.  
  17. General use
  18. ===========
  19.  
  20. GED_AsciiReg requires at least AmigaOS 2.04 and is only useful if you own
  21. GoldED V4+. Shell use only.
  22.  
  23. GED_AsciiReg reads the registry files of GoldED (GOLDED:registry/) and
  24. saves them as plain ASCII files. You may edit them with your favourite text
  25. editor. Afterwards GED_AsciiReg converts the ASCII files back to registry
  26. files.
  27. Main use is for mouse, gadgets, keyboard and menu registry files, otherwise
  28. the GoldED GUI is IMHO the better choice.
  29.  
  30. Usage: GED_AsciiReg [LONG] File/M
  31.  
  32. GED_AsciiReg automatically recognizes the file (registry or ASCII file) via
  33. the first 4 bytes ("OOP\0" or "AREG") and converts it corresponding.
  34. Written ASCII files always get the suffix ".gtxt" appended, written
  35. registry files get the ".gtxt" suffix removed (if present) or the suffix
  36. ".greg" appended.
  37.  
  38. If argument LONG is present (must be first argument!), OBJECT_EVENT_EVENT
  39. lists (command definitions) will be written as standard lists not with special
  40. keyword X(KEY)EVENT.
  41.  
  42.  
  43. Some more words
  44. ===============
  45.  
  46. GED_AsciiReg depends heavily on the structure of the registry files. If
  47. Dietmar changes or extends it this program might fail and/or break your
  48. configuration. The ASCII file includes at the top the GoldED version for
  49. which GED_AsciiReg is written.
  50. I have implemented quite a lot of checking so only known structures will be
  51. converted but this is not 100 % safe. I suggest following use: Make a
  52. backup of your registry files. Convert them to ASCII and afterwards
  53. immediatly back. Now (binary) compare your backups against the reconverted
  54. registry files. There should be NO difference. If so, send me your
  55. (original) registry file and the converted ASCII file, please.
  56.  
  57.  
  58. ASCII file format
  59. =================
  60.  
  61. First four bytes must be "AREG". Empty lines and lines which first nonblank
  62. character is ";" (semicolon) will be ignored.
  63.  
  64. Every line (exceptions see below) is parsed with the template
  65. OBJECT/A,NAME/K,NUMBER/K/N,STRING/K,DATA/K,LIST/K/N.
  66. OBJECT is the name of the GoldED objekt with or without the "OBJECT_"
  67. prefix. For a list see file GOLDED:developer/registry/include/registry.h.
  68. Unknown object ids (e. g. of GoldED 4.7.0) have as name "UNKNOWN_#" where
  69. "#" is the id number.
  70. NAME specifies the object name. The last four arguments give the data type
  71. and the data itself; only one of them must be specified. LIST specifies the
  72. number of child objects.
  73.  
  74. Two special keywords exist for command definitions (OBJECT_EVENT_EVENT list
  75. with 10 child objects): XEVENT and XKEYEVENT.
  76.  
  77. Template for XEVENT: NAME/K,COMMANDS/M,KEYCODE/N/K,ASYNC/S,SHANGHAITIME/N/K,
  78.         OUTPUT/K,HYPERNODE/K,DIRECTORY/K,VARIABLE/K,SHORTCUT/K
  79.  
  80. Template for XKEYEVENT which is only used within the OBJECT_KEY_KEYS list
  81. in the keyboard registry file: KEYCODE/A/K,COMMANDS/M,ASYNC/S,
  82.         SHANGHAITIME/N/K,OUTPUT/K,DIRECTORY/K
  83.  
  84. Unspecified arguments default to 0 (zero), FALSE or "" (empty string).
  85. Strings for COMMANDS have following format: "T:command" where T gives the
  86. command typ (N for not definied, I for internal, D for AmigaDOS, A for
  87. ARexx, T for text and S for sequence) and command is the command string.
  88.  
  89. For XKEYEVENT the KEYCODE argument is parsed with following template:
  90. NUM/S,CTRL/S,ALT/S,SHIFT/S,RAW/S,CODE/A.
  91. CODE can be a three digit decimal number (e. g. "029"), a single character
  92. (only for non-raw keys) which ASCII is taken or a key description
  93. (currently BACK, TAB, CR, ESC, SPC, DEL for non-raw keys and BACKTAB, UP,
  94. DOWN, RIGHT, LEFT, F01 - F10, HELP for raw keys). The RAW flag must be set
  95. even on key descriptions for raw keys (e. g. "SHIFT F01" is wrong, it must
  96. be "SHIFT RAW F01").
  97.  
  98. Best example is a freshly converted registry file and GoldED`s GUI
  99. configuration next to each other.
  100.  
  101. Remember: Every line is parsed with ReadArgs() so double quotes " and *
  102. must be escaped with one *. Example: the string ab*cde"*" must be given as
  103. ab**cde*"***". Special characters (?, = and ;) must always be enclosed in
  104. double quotes.
  105. Even more complex is the parsing of KEYCODE argument of XKEYEVENT: the string
  106. is parsed twice. If you want to specify double quotes ("), you have to use
  107. KEYCODE="*"***"*"" because after first parsing (for XKEYEVENT template)
  108. "*"" is left which is parsed to your wich ". For the equal sign you have to
  109. use KEYCODE="*"=*"" (after first parsing "=" is left).
  110.  
  111.  
  112. Copyright, warrenty
  113. ===================
  114.  
  115. GED_AsciiReg is FreeWare, Copyright (c) 1997 Thies Wellpott.
  116.  
  117. Usage is completely on your own risk, no warrenty at all.
  118.  
  119.  
  120. History
  121. =======
  122.  
  123. V1.0   20.3.1997
  124. - first release
  125.  
  126. V1.1   16.4.1997
  127. - recognizes GoldED 4.6.0 objects
  128. - handles unknown object ids nicely
  129.  
  130. V1.2   22.4.1997
  131. - special handling of ", ?, = and ; implemeted (thanks to Wolfgang Morgeneier
  132.   for reporting this bug)
  133.  
  134.  
  135. Author
  136. ======
  137.  
  138. Thies Wellpott
  139.  
  140. EMail: thies.wellpott@informatik.uni-oldenburg.de
  141.  
  142. Homepage: http://www.informatik.uni-oldenburg.de/~thies
  143.  
  144. Snail: Moorhauser Weg 14
  145.        26419 Schortens
  146.        Germany
  147.  
  148.  
  149. Suggestions, bug reports and gifts are always welcome!
  150.  
  151.